Loading TOC...

PUT /manage/v2/databases/{id|name}/alert/actions/{id|name}/rules/{id|name}/properties

Summary

This resource address updates the configuration properties of the specified alert rule.

URL Parameters
uri The URI of the alert. This parameter is required.
format The format of the posted data. Can be either json or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the request body. If the format? parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns a status code 200 (OK). If the payload is malformed or the alert rule does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires one of the following:

Usage Notes

The properties that can be modified are listed below.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, options is expressed in singular form.

name

description

user-id

query

action-name

external-security-id

user-name

options

Example


curl -X PUT --digest -u admin:admin -H "Content-type: application/json" \
-d '{  
    "description": "New Description"
   }' \
http://localhost:8002/manage/v2/databases/Documents/alert/actions/xdmp:log2/rules/my-rule/properties?uri=my-alert-config

==>  Updates the "description" properties of the "my-rule" alert rule.

Example


curl -X PUT --digest -u admin:admin -H "Content-type: application/json" \
-d '{
    "description": "New Description",
    "query": {
        "andQuery": {
            "queries": [
                {
                    "notQuery": {
                        "query": {
                            "collectionQuery": {
                                "uris": [
                                    "newest"
                                ]
                            }
                        }
                    }
                },
                {
                    "collectionQuery": {
                        "uris": [
                            "uni-temporal"
                        ]
                    }
                },
                {
                    "elementRangeQuery": {
                        "element": [
                            "systemEnd"
                        ],
                        "operator": ">",
                        "value": [
                            {
                                "type": "dateTime",
                                "val": "2021-12-01T00:00:00"
                            }
                        ]
                    }
                },
                {
                    "notQuery": {
                        "query": {
                            "collectionQuery": {
                                "uris": [
                                    "whatsup"
                                ]
                            }
                        }
                    }
                }
            ]
        }
    }
}' \
http://localhost:8002/manage/v2/databases/Documents/alert/actions/xdmp:log2/rules/my-rule/properties?uri=my-alert-config

==>  Updates the "description" and "query" properties of the "my-rule" alert rule.

Example


curl -X PUT --digest -u admin:admin -H "Content-type: application/xml" \
-d '<alert-rule-properties xmlns="http://marklogic.com/manage/alert-rule/properties">
    <description>Description for XML</description>
    <query>
        <cts:and-query xmlns:cts="http://marklogic.com/cts">
            <cts:not-query>
                <cts:collection-query>
                    <cts:uri>newest</cts:uri>
                </cts:collection-query>
            </cts:not-query>
            <cts:collection-query>
                <cts:uri>uni-temporal</cts:uri>
            </cts:collection-query>
            <cts:element-range-query operator="&gt;">
                <cts:element>systemEnd</cts:element>
                <cts:value xsi:type="xs:dateTime" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2021-12-01T00:00:00</cts:value>
            </cts:element-range-query>
        </cts:and-query>
    </query>
</alert-rule-properties>' \
http://localhost:8002/manage/v2/databases/Documents/alert/actions/xdmp:log2/rules/my-rule/properties?uri=my-alert-config

==>  Updates the "description" and "query" properties of the "my-rule" alert rule.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.